home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 20 / Cream of the Crop 20 (Terry Blount) (1996).iso / os2 / nftp080.zip / nftp-man.txt < prev    next >
Text File  |  1996-07-12  |  44KB  |  1,071 lines
  1. DRAFT. EXPECT SOME OMISSIONS AND INACCURACIES
  2. -------------------------------------------------------------------------------
  3.  
  4. NFTP : New File Transfer Protocol Client Version 0.80
  5. Copyright (C) 1994-1996 Sergey Ayukov
  6.  
  7. -------------------------------------------------------------------------------
  8. Home page of NFTP. Check it for new versions, updates etc.
  9.  
  10. Contents
  11.  
  12.   1. Introduction
  13.   2. Installation
  14.   3. Quick start
  15.   4. Usage
  16.         o Launching NFTP
  17.         o Logging in and out
  18.         o Navigating remote site and local directories
  19.         o Transferring files
  20.         o Customizing NFTP
  21.   5. Keyboard commands summary
  22.         o General keyboard commands
  23.         o Control connection window
  24.         o File listing (remote and local)
  25.         o Entry fields
  26.         o Bookmark list
  27.         o Built-in file viewer
  28.   6. Known bugs and limitations
  29.   7. Troubleshooting
  30.   8. Licensing information
  31.   9. Acknowledgements
  32.  10. Registration
  33.  11. Contacting the author
  34.  
  35. Version history
  36. -------------------------------------------------------------------------------
  37.  
  38. INTRODUCTION
  39.  
  40. NFTP is a text-mode ftp client for OS/2. Comparing to popular ncftp, it has a
  41. number of enhancements:
  42.  
  43.    *  remote directory view is fully scrollable with minimum keystrokes
  44.      required;
  45.    *  remote directory contents is cached during one session - you'll never
  46.      have to wait for retrieving the same listing;
  47.    *  marking files for download/upload: you don't need to type filenames at
  48.      all;
  49.    *  remote file viewing is more simple and intelligent, and viewed files are
  50.      cached as well;
  51.    *  you can see client-server negotiation (even complete history during all
  52.      run);
  53.    *  NFTP has batch progress indicator (you see how long will take entire
  54.      operation if more than one file was selected to transfer);
  55.    *  file selection is simple and allows to view remote files while marking
  56.      others to transfer;
  57.    *  you can skip files during transfer while continuing to download/upload
  58.      the rest;
  59.    *  you can mark files in different directories and then retrieve them all;
  60.    *  you can sort remote directories by name, size, date/time.
  61.    *  NFTP comes in 12 languages: Brazilian Portuguese, Chinese, Danish,
  62.      English, German, Hungarian, Italian, Japanese, Norwegian, Russian,
  63.      Spanish, Swedish.
  64.  
  65. The biggest advantages over majority of PM ftp clients (like FTP-PM, sftp etc.)
  66. are the ability to 'reget' (continue transfer after interruption), speed of
  67. simple and effective text-mode interface, small memory requirements.
  68.  
  69. In my opinion, LW-FTP while being very elegant is useless due to big overhead
  70. of Workplace Shell object creation/deletion.
  71.  
  72. The drawback, however, is that NFTP isn't free as ncftp. But registration fee
  73. is only US$ 20 -- and you'll get all future versions and support by e-mail at
  74. this price! See registration details below.
  75. -------------------------------------------------------------------------------
  76.  
  77. INSTALLATION
  78.  
  79.   1. Requirements are
  80.         o  OS/2 2.x or later;
  81.         o  TCP/IP stack: IBM TCP/IP 2.0 for OS/2, OS/2 Warp Connect, OS/2 Warp
  82.           Internet Access Kit;
  83.         o  HPFS formatted drive to be able to download files which are not
  84.           8.3-compliant.
  85.         o  In addition, you also have to install emx runtime package. If you
  86.           don't have it installed, file "emx.dll" is supplied with this version
  87.           of NFTP. Copy it into any directory listed in your LIBPATH. The
  88.           latest version of emx runtime support package can be found at the
  89.           following ftp servers:
  90.           ftp.uni-stuttgart.de:/pub/systems/os2/emx-0.9b/emxrt.zip
  91.           ftp.sai.msu.su:/pub/os2/programming/emx-0.9b/emxrt.zip
  92.           Instructions on installing it can be found in emxrt.zip archive.
  93.   2. Installation.
  94.  
  95.      Unpack archive nftp*.zip into some directory and run install.cmd. After
  96.      answering some questions necessary files will be copied to the directory
  97.      you specified and your WPS desktop will hold two new objects -- "NFTP"
  98.      (executable) and "NFTP Manual". You probably already done that because
  99.      you're reading that "NFTP Manual"!
  100.  
  101.      If you want to install NFTP by hand (without install.cmd), copy all files
  102.      into the directory of your choice (eg, "d:\apps\tcpip\nftp"), load
  103.      nftp.ini into your favourite ASCII text editor (eg, TEDIT shipped with
  104.      Warp) and insert your e-mail address (it will be used as a password for
  105.      anonymous logins) at the appropriate place (line
  106.  
  107.                anonymous-password="your-e-mail-address"
  108.  
  109.  
  110.      ). I also suggest to decide where you will keep your bookmarks and
  111.      transfer history and set corresponding variables accordingly. If you like
  112.      to launch programs from desktop, create program object for NFTP. Put
  113.      supplied nftp.mrk file into the directory which you've chosen in nftp.ini.
  114.  
  115.      The language NFTP uses is determined by environment variable NFTP_LANG. It
  116.      should be set to the name (without extension) of corresponding DLL file.
  117.      E.g., if you want to use Japanese version, you should use
  118.  
  119.                set NFTP_LANG=japanes
  120.  
  121.  
  122.      This statement can be put to config.sys or to the batch file invoking nftp
  123.      (install.cmd does exactly this). If you only need English version you may
  124.      omit this variable.
  125.  
  126.      install.cmd creates Workplace shell object to run NFTP. This feature can
  127.      be useful even you are die-hard command-line user (see below). NFTP can
  128.      run in a fullscreen session or in a VIO window. Installation script sets
  129.      it to run in a window, and window will not be closed automatically after
  130.      exit -- this can help to diagnose problems. Turn it off when everything
  131.      works as expected.
  132.  
  133. -------------------------------------------------------------------------------
  134.  
  135. QUICK START
  136.  
  137. After installation, run nftp.exe (from command line or WPS object). If you're
  138. launching NFTP from WPS object created by installation script you will be asked
  139. to enter "FTP server to log in"; simply press ENTER now. You should see list of
  140. bookmarks on the screen. Use cursor keys to select one of them and press ENTER.
  141. If everything is set up correctly, you'll see client-server negotiation and
  142. then finally list of files and directories on the ftp server you've chosen. Hit
  143. SPACE to view control connection window (and it is scrollable!), TAB to view
  144. local files/directories. Return to remote directory view by pressing space/tab
  145. another time. Move pointer with cursor keys, press ENTER on a directory to
  146. enter it. Select files to download with INSERT or simply press F5 to transfer
  147. single file. To upload file to server, switch to local files view (with TAB),
  148. select file(s) and press Shift-F5. To view local or remote file, move pointer
  149. to it and press F3 (of course, remote file will be downloaded first -- that
  150. will probably take some time). Navigating in the viewer is simple and
  151. intuitive: scroll file with cursor keys. Press F10 to log off and exit NFTP.
  152. -------------------------------------------------------------------------------
  153.  
  154. USAGE: LAUNCHING NFTP
  155.  
  156. You often already know where the file you need right now is located. Let's
  157. suppose, say, you want to retrieve RFC 959 from
  158.  
  159.        src.doc.ic.ac.uk:/pub/rfc/
  160.  
  161.  
  162. Launch nftp in the following fashion:
  163.  
  164.        nftp  src.doc.ic.ac.uk:/pub/rfc
  165.  
  166.  
  167. or
  168.  
  169.        nftp  src.doc.ic.ac.uk/pub/rfc
  170.  
  171.  
  172. After logging in into src.doc.ic.ac.uk nftp will change directory for you to
  173. /pub/rfc. You will then locate required file and download it.
  174.  
  175. The command line format for NFTP is:
  176.  
  177.       nftp [hostname[[:[port]]directory]   [userid]
  178.  
  179.  
  180. "hostname" is the name of ftp server ('src.doc.ic.ac.uk' in the above example),
  181. ":" can be omitted, "directory" is remote directory ('/pub/rfc' in the above
  182. example), "port" is port number (don't use it if you don't know what's it). If
  183. you have an account on ftp server (i.e. you're not anonymous user), you can
  184. specify your userid in the command line. You will be asked for a password. An
  185. important note -- there shouldn't be any spaces between hostname and directory!
  186. Another examples are:
  187.  
  188.       nftp private.crlf.net:7500/users    (nonstandard port)
  189.       nftp ftp/pub